README: reformat, add install/run instructions, and add NeuroMathSchool note#4
Closed
Andrianarivelo wants to merge 1 commit intomainfrom
Closed
README: reformat, add install/run instructions, and add NeuroMathSchool note#4Andrianarivelo wants to merge 1 commit intomainfrom
Andrianarivelo wants to merge 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This is a documentation-only README refresh intended to improve onboarding for the fiber photometry GUI by standardizing formatting, clarifying setup/run steps, and expanding workflow guidance.
Changes:
- Reformats the README for more consistent Markdown structure and sectioning.
- Adds explicit Conda environment creation, activation, and GUI launch steps.
- Updates workflow/repository notes and adds a NeuroMathSchool collaboration note.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+79
to
+84
| - `analysis_core.py` | ||
| Processing pipeline (loading, filtering, baselines, outputs, export helpers) | ||
| - `main.py` (or similar) | ||
| PySide6 GUI entry point and UI wiring | ||
| - `environment.yml` | ||
| Conda environment definition |
|
|
||
| ### Behavior file formats | ||
| - **CSV**: must include a time column and one or more binary behavior columns | ||
| - **Ethovision XLSX**: the loader preprocess and clean the file; the user must select the sheet when loading |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
README.mdwith consistent Markdown structure, restored separators, and cleaned up bullets and code spans for commands and filenames.conda env create -f environment.yml,conda activate pyBer, andpython main.pyinpyBer.environment.ymland clarified usage, preprocessing, post-processing, and behavior file loader wording.NeuroMathSchoolcollaboration note suggesting a minimal integration path for curriculum/demos.Testing
Codex Task